home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sspgvd.z / sspgvd
Encoding:
Text File  |  2002-10-03  |  7.6 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSPPPPGGGGVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSPPPPGGGGVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSPGVD - compute all the eigenvalues, and optionally, the eigenvectors of
  10.      a real generalized symmetric-definite eigenproblem, of the form
  11.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE SSPGVD( ITYPE, JOBZ, UPLO, N, AP, BP, W, Z, LDZ, WORK, LWORK,
  15.                         IWORK, LIWORK, INFO )
  16.  
  17.          CHARACTER      JOBZ, UPLO
  18.  
  19.          INTEGER        INFO, ITYPE, LDZ, LIWORK, LWORK, N
  20.  
  21.          INTEGER        IWORK( * )
  22.  
  23.          REAL           AP( * ), BP( * ), W( * ), WORK( * ), Z( LDZ, * )
  24.  
  25. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  26.      These routines are part of the SCSL Scientific Library and can be loaded
  27.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  28.      directs the linker to use the multi-processor version of the library.
  29.  
  30.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  31.      4 bytes (32 bits). Another version of SCSL is available in which integers
  32.      are 8 bytes (64 bits).  This version allows the user access to larger
  33.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  34.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  35.      only one of the two versions; 4-byte integer and 8-byte integer library
  36.      calls cannot be mixed.
  37.  
  38. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  39.      SSPGVD computes all the eigenvalues, and optionally, the eigenvectors of
  40.      a real generalized symmetric-definite eigenproblem, of the form
  41.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x. Here A and B are
  42.      assumed to be symmetric, stored in packed format, and B is also positive
  43.      definite.
  44.      If eigenvectors are desired, it uses a divide and conquer algorithm.
  45.  
  46.      The divide and conquer algorithm makes very mild assumptions about
  47.      floating point arithmetic. It will work on machines with a guard digit in
  48.      add/subtract, or on those binary machines without guard digits which
  49.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  50.      conceivably fail on hexadecimal or decimal machines without guard digits,
  51.      but we know of none.
  52.  
  53.  
  54. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  55.      ITYPE   (input) INTEGER
  56.              Specifies the problem type to be solved:
  57.              = 1:  A*x = (lambda)*B*x
  58.              = 2:  A*B*x = (lambda)*x
  59.              = 3:  B*A*x = (lambda)*x
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSPPPPGGGGVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSPPPPGGGGVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      JOBZ    (input) CHARACTER*1
  75.              = 'N':  Compute eigenvalues only;
  76.              = 'V':  Compute eigenvalues and eigenvectors.
  77.  
  78.      UPLO    (input) CHARACTER*1
  79.              = 'U':  Upper triangles of A and B are stored;
  80.              = 'L':  Lower triangles of A and B are stored.
  81.  
  82.      N       (input) INTEGER
  83.              The order of the matrices A and B.  N >= 0.
  84.  
  85.      AP      (input/output) REAL array, dimension (N*(N+1)/2)
  86.              On entry, the upper or lower triangle of the symmetric matrix A,
  87.              packed columnwise in a linear array.  The j-th column of A is
  88.              stored in the array AP as follows:  if UPLO = 'U', AP(i + (j-
  89.              1)*j/2) = A(i,j) for 1<=i<=j; if UPLO = 'L', AP(i + (j-1)*(2*n-
  90.              j)/2) = A(i,j) for j<=i<=n.
  91.  
  92.              On exit, the contents of AP are destroyed.
  93.  
  94.      BP      (input/output) REAL array, dimension (N*(N+1)/2)
  95.              On entry, the upper or lower triangle of the symmetric matrix B,
  96.              packed columnwise in a linear array.  The j-th column of B is
  97.              stored in the array BP as follows:  if UPLO = 'U', BP(i + (j-
  98.              1)*j/2) = B(i,j) for 1<=i<=j; if UPLO = 'L', BP(i + (j-1)*(2*n-
  99.              j)/2) = B(i,j) for j<=i<=n.
  100.  
  101.              On exit, the triangular factor U or L from the Cholesky
  102.              factorization B = U**T*U or B = L*L**T, in the same storage
  103.              format as B.
  104.  
  105.      W       (output) REAL array, dimension (N)
  106.              If INFO = 0, the eigenvalues in ascending order.
  107.  
  108.      Z       (output) REAL array, dimension (LDZ, N)
  109.              If JOBZ = 'V', then if INFO = 0, Z contains the matrix Z of
  110.              eigenvectors.  The eigenvectors are normalized as follows:  if
  111.              ITYPE = 1 or 2, Z**T*B*Z = I; if ITYPE = 3, Z**T*inv(B)*Z = I.
  112.              If JOBZ = 'N', then Z is not referenced.
  113.  
  114.      LDZ     (input) INTEGER
  115.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  116.              'V', LDZ >= max(1,N).
  117.  
  118.      WORK    (workspace/output) REAL array, dimension (LWORK)
  119.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  120.  
  121.      LWORK   (input) INTEGER
  122.              The dimension of the array WORK.  If N <= 1,               LWORK
  123.              >= 1.  If JOBZ = 'N' and N > 1, LWORK >= 2*N.  If JOBZ = 'V' and
  124.              N > 1, LWORK >= 1 + 6*N + 2*N**2.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSPPPPGGGGVVVVDDDD((((3333SSSS))))                                                          SSSSSSSSPPPPGGGGVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              If LWORK = -1, then a workspace query is assumed; the routine
  141.              only calculates the optimal size of the WORK array, returns this
  142.              value as the first entry of the WORK array, and no error message
  143.              related to LWORK is issued by XERBLA.
  144.  
  145.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  146.              On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  147.  
  148.      LIWORK  (input) INTEGER
  149.              The dimension of the array IWORK.  If JOBZ  = 'N' or N <= 1,
  150.              LIWORK >= 1.  If JOBZ  = 'V' and N > 1, LIWORK >= 3 + 5*N.
  151.  
  152.              If LIWORK = -1, then a workspace query is assumed; the routine
  153.              only calculates the optimal size of the IWORK array, returns this
  154.              value as the first entry of the IWORK array, and no error message
  155.              related to LIWORK is issued by XERBLA.
  156.  
  157.      INFO    (output) INTEGER
  158.              = 0:  successful exit
  159.              < 0:  if INFO = -i, the i-th argument had an illegal value
  160.              > 0:  SPPTRF or SSPEVD returned an error code:
  161.              <= N:  if INFO = i, SSPEVD failed to converge; i off-diagonal
  162.              elements of an intermediate tridiagonal form did not converge to
  163.              zero; > N:   if INFO = N + i, for 1 <= i <= N, then the leading
  164.              minor of order i of B is not positive definite.  The
  165.              factorization of B could not be completed and no eigenvalues or
  166.              eigenvectors were computed.
  167.  
  168. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  169.      Based on contributions by
  170.         Mark Fahey, Department of Mathematics, Univ. of Kentucky, USA
  171.  
  172.  
  173. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  174.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  175.  
  176.      This man page is available only online.
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.